/*
 * Copyright (c) 2012 copyright Gábor Heizer
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
 * is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package hu.my.bnf;

import hu.my.bnf.validation.Validator;
import org.jetbrains.annotations.Nullable;

/**
 * BNF interface.
 */
public interface BNF extends Validator {

    /**
     * Get the comment associated with this BNF.
     *
     * @return String Text <code>String</code> text for comment.
     */
    String getComment();

    /**
     * Return the MetaIdentifier.
     *
     * @return String The MetaIdentifier.
     */
    String getMetaIdentifier();

    /**
     * Return the URN.
     *
     * @return String The URN.
     */
    String getUrn();

    /**
     * This will set the value of the comment.
     *
     * @param comment Text <code>String</code> content of comment.
     */
    void setComment(@Nullable String comment);
}
